Fetch Pix Scheduling

Fetch all scheduled Automatic Pix

Request

GET 'https://apisandbox.delbank.com.br/baas/api/v1/pix/automatic/scheduling'

Headers

Name	Description
Authorization	Required. API key

Query Parameters:

Name	Type	Description
flow	number	Required. Which journey to search for, 0 for payer or 1 for receiver
beneficiaryDocument	string	Optional. The document of the receiver (max 14 characters)
payerPersonType	number	Optional. The type of person: 0 for Natural Person, 1 for Legal Person
payerDocument	string	Optional. The document of the sender (max 14 characters)
status	string	Optional. The status of the schedule
dueDateStart	date	Required. The start date of the query (Date format)
dueDateEnd	date	Required. The end date of the query (Date format)
page	number	Optional. The page number (Default: 1). Must be a positive number
pageSize	number	Optional. The amount of results returned per page (Default: 50, Max: 100)

Response

The status code 200 indicates success in the query.

Being succeeded, the return will have the following fields in Json format:

{
    "data": [
        {
            "endToEndId": "E3822485720250610120000010000001",
            "beneficiaryConciliationId": "RR4002892220250429ABCDE122131",
            "scheduleStatus": "ACCEPTED",
            "acceptRejectAt": "0001-01-01T00:00:00Z",
            "requestAt": "2025-06-10T16:08:21.284Z",
            "situationAt": "2025-07-11T15:03:32.027Z",
            "processingStatus": "PENDING_USER",
            "status": "PROCESSING",
            "errorCode": null,
            "errorCodeDescription": null,
            "recurrenceId": "RR4002892220250429ABCDE122131",
            "beneficiaryPspReceivedAt": "2025-06-10T15:54:39.494Z",
            "dueDate": "2025-06-12",
            "amount": 150.75,
            "beneficiary": {
                "ispb": "38224857",
                "document": "03284584000162",
                "name": "corporateName",
                "branchNumber": "0001",
                "accountType": "PAYMENT",
                "accountNumber": "99999"
            },
            "payer": {
                "ispb": "38224857",
                "type": "NATURAL",
                "document": "12345678901",
                "branchNumber": "0001",
                "accountNumber": "99998"
            },
            "infoBetweenCustomers": "Contrato: Teste Alisson - Assinatura Exclusive Ultra",
            "schedulePurpose": "FIRST_ATTEMPT",
            "cancellations": [
                {
                    "cancellationId": "CA3822485720250616Jgs0xZD3uAV",
                    "requesterIspb": "38224857",
                    "recipientIspb": "38224857",
                    "cancellationRequesterType": "LEGAL",
                    "cancellationRequesterDocument": "03284584000162",
                    "cancellationReason": "REQUESTED_BY_PAYEE",
                    "cancellationAt": "2025-06-16T17:08:36.679Z",
                    "cancellationStatus": "ACCEPTED",
                    "errorCode": null,
                    "errorCodeDesc": null
                }
            ]
        }
    ],
    "pagination": {
        "pageNumber": 1,
        "pageSize": 50,
        "totalPages": 1,
        "totalRecords": 1,
        "hasPreviousPage": false,
        "hasNextPage": false
    }
}